Repository navigation
docs: bring command maps, references and how-tos up to date - #47
Merged
Merged
Conversation
AGENTS.md left latest out of the package line and capacity out of the stack line. The MCP list in cli.org skipped eb_stack_footprints and eb_stack_admit, which mcp.rs registers and mcp.org lists. docs/campaign-boundary.md cited src/campaign.rs and src/foreign.rs lines from commit 1fd9fb5, up to 140 lines off now, and still named request.target for the stage, build and verify calls that run_campaign makes on run_target. Every reference was checked against the current source. A staging failure is recorded as a Transport finding in place; the preflight, build and verify call sites go through record_target_command_failure. The shard how-to never said that stack shard drops what --filter-deps names and otherwise reads EASYBUILD_FILTER_DEPS. Planned outside EESSI-extend, the compatibility-layer packages it filters count as missing and the shared ones land in the prelude. The PyPI and CRAN how-tos asked for the EESSI robot tree without saying where it is: the easyconfigs bundled with EESSI's EasyBuild module, which holds the 2026.06 bundles. The commented pins in the two EESSI example policies named 2025 bundles under a foss/2026.1 toolchain; they name SciPy-bundle 2026.05, Python-bundle-PyPI 2026.04, R 4.6.1 and R-bundle-CRAN 2026.07, the versions EESSI 2026.06 ships. The provides module doc linked Candidate::EXT_PROVIDE_MARKER, which does not exist, so cargo doc with -D rustdoc::broken-intra-doc-links failed on it; the link now names the module's own EXT_PROVIDE_MARKER. Two campaign doc comments carried a doubled ///.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs match the code again: command maps, the MCP list, line references, filter-deps and robot-tree guidance, the EESSI 2026.06 pins, a rustdoc link, and a doubled
///.AGENTS.mdlistspackage latestandstack capacity. Thecli.orgMCP list nameseb_stack_footprintsandeb_stack_admit.docs/campaign-boundary.mdcites the currentsrc/campaign.rsandsrc/foreign.rslines and therun_targetcalls. The shard how-to says to plan with EESSI-extend'sEASYBUILD_FILTER_DEPS, or pass that list as--filter-deps. The PyPI and CRAN how-tos say the robot tree is$EBROOTEASYBUILD/easybuild/easyconfigsfrom EESSI's EasyBuild module. The commented pins in the EESSI example policies name the EESSI 2026.06 bundles. TheprovidesandcampaignAPI docs have no broken link or stray///.The commit has a towncrier fragment. Main has no towncrier yet; #26 (
fix/towncrier) adds it.